/*
hashmap是map的子类
是一个基于散列表的结构
和hashtable的区别是支持null key和null value,非线程同步的
有两个关键参数 一个是散列表的长度, 一个是加载因子
散列表的初始长度不要太大,加载因子不要太小
加载因子默认是0.75 是基于时间和空间开销的考虑

*/

    /**
     * The default initial capacity - MUST be a power of two.
     * 散列表初始化长度,必须是2的倍数,默认值是16
     */
    static final int DEFAULT_INITIAL_CAPACITY = 1 << 4; // aka 16

    /**
     * The maximum capacity, used if a higher value is implicitly specified
     * by either of the constructors with arguments.
     * MUST be a power of two <= 1<<30.
     * 散列表长度的最大值, 是2的30次方
     * 因为长度是一个int值, 最大值是2的31次方-1
     */
    static final int MAXIMUM_CAPACITY = 1 << 30;

    /**
     * The load factor used when none specified in constructor.
     * 当我们使用无参构造的时候默认的加载因子
     */
    static final float DEFAULT_LOAD_FACTOR = 0.75f;

    /**
     * The bin count threshold for using a tree rather than list for a
     * bin.  Bins are converted to trees when adding an element to a
     * bin with at least this many nodes. The value must be greater
     * than 2 and should be at least 8 to mesh with assumptions in
     * tree removal about conversion back to plain bins upon
     * shrinkage.
     * 当我们的散列表中某个数据的数量长度到达当前值的情况下,这个位置的数据
     * 会从链表转换为红黑树,这个值必须大于2,最好设置为8,原因是泊松分布
     */
    static final int TREEIFY_THRESHOLD = 8;

    /**
     * The bin count threshold for untreeifying a (split) bin during a
     * resize operation. Should be less than TREEIFY_THRESHOLD, and at
     * most 6 to mesh with shrinkage detection under removal.
     * 当某个位置的数据已经变成树节点的情况下,什么时候变回链表,当数据的长度小于等于6的时候 会变回链表
     */
    static final int UNTREEIFY_THRESHOLD = 6;

    /**
     * The smallest table capacity for which bins may be treeified.
     * (Otherwise the table is resized if too many nodes in a bin.)
     * Should be at least 4 * TREEIFY_THRESHOLD to avoid conflicts
     * between resizing and treeification thresholds.
     * 并不是某个节点的数据长度到达指定的阈值之后就立刻变成树节点,还要判断下当前散列表的总长度是不是大于64,如果不到64会先进行扩容,重新排列数据看看能不能打乱
     * 注意这个值建议至少是TREEIFY_THRESHOLD变量的4倍
     */
    static final int MIN_TREEIFY_CAPACITY = 64;

    /**
     * Basic hash bin node, used for most entries.  (See below for
     * TreeNode subclass, and in LinkedHashMap for its Entry subclass.)
     * 散列表每个位置存放的数据的格式
     */
    static class Node<K,V> implements Map.Entry<K,V> {
        final int hash;//key的hash值,不是hashcode
        final K key;//key
        V value;//value
        Node<K,V> next;//当前节点的下一个数据,可以实现链表和树

        Node(int hash, K key, V value, Node<K,V> next) {
            this.hash = hash;
            this.key = key;
            this.value = value;
            this.next = next;

    }
}



    /**
     * The table, initialized on first use, and resized as
     * necessary. When allocated, length is always a power of two.
     * (We also tolerate length zero in some operations to allow
     * bootstrapping mechanics that are currently not needed.)
     * 散列表,其实所谓散列表就是一个数组,数组里面每个位置上的数据是一个Node类型的对象,所谓的每个节点其实就数组的每个位置
     * 每个位置上的Node都可以通过next指向下一个数据,可以将存在当前位置的数据变成一个链表
     */
    transient Node<K,V>[] table;


    /**
     * The next size value at which to resize (capacity * load factor).
     * 阈值,扩容的阈值,当散列表的数据的数量大于等于当前的值的时候就会触发扩容, 这个值等于散列表的长度乘以加载因子
     * 用这个变量的目的是不用每次都计算这个值,用这个变量保存乘的结果,这样直接可以判断,等到扩容之后重新计算
     */
    int threshold;

    /**
     * The load factor for the hash table.
     * 加载因子,可以自己指定,不指定的情况下就是默认的加载因子的值
     */
    final float loadFactor;


/**
 * hashmap,hashmap 肯定和hash相关,也就是需要一个散列的算法,这个算法的目的就是为了确定一个数据在散列的数组中应该存放到哪个位置
 * jdk1.8开始修改了当前的算法,结果等于key的hashcode值异或上hashcode值向右无符号右移16位
 * 如果key是null ,则直接返回0,也就是说null这个key会保存在0这个位置
 * 让高16位参与运算的主要目的是 比如初始化长度是16的情况下,计算位置的方式是(16-1)&hash值,因为15的二进制只有最后四位是1,所以后面的hash的值不管是什么,最终结果只取决于hash的最后四位
 * 而如果两个key hashcode的值不一样,但是刚好最后4位是一样的所以在和15与完之后,结果一样了,也就是不一样的key去了一样的位置
 * 我们让hashcode和自己的高16位参与运算的目的是期望能改变低位的值,也就是原先我们最后4位是一样的,但是高16位来参与了运算之后反而不一样了,这样子我们的数据就可以保存到不同的位置了
 * 提升了查询的效率
 */
 static final int hash(Object key) {
    int h;
    return (key == null) ? 0 : (h = key.hashCode()) ^ (h >>> 16);
}


/**
 * 添加数的方法
 */

final V putVal(int hash, K key, V value, boolean onlyIfAbsent,
                   boolean evict) {
        Node<K,V>[] tab; Node<K,V> p; int n, i;//声明了几个局部变量,分别是一个node数组,一个node变量, 两个int值
        //首先将外面的散列表的数组赋值给当前的局部变量,然后判断是不是null或者长度是不是0 ,对于第一次来说,是null
        if ((tab = table) == null || (n = tab.length) == 0)
            n = (tab = resize()).length;//局部变量等于resize()方法的返回值, 并且n等于返回值的长度,resize就是库容的方法,可以判断,hashmap在初始化的时候不会创建数据,而是在第一次存放数据的时候才会创建,默认会创建一个长度为16的数组
        if ((p = tab[i = (n - 1) & hash]) == null)//根据新的长度-1 &key的hash 得到一个下标位置,然后获取到数组这个下标位置的数据,看看是不是空的,如果是空的
            tab[i] = newNode(hash, key, value, null); //以当前要保存的数据作为构造参数,创建一个node对象,并保存到这个下标位置
        else {//如果现在这个位置有数据
            Node<K,V> e; K k;
            if (p.hash == hash &&//如果当前位置上的数据的hash和要存放的数据的hash是一样,并且当前位置上的数据的key和存放的数据的key也是一样的
                ((k = p.key) == key || (key != null && key.equals(k))))
                e = p;//临时变量e接收当前这个位置的数据
            else if (p instanceof TreeNode)//如果当前的位置是树类型的节点
                e = ((TreeNode<K,V>)p).putTreeVal(this, tab, hash, key, value);//以树的方式保存数据
            else {//佛则,就说明当前这个数据和我们要存放的数据不一样,应该挂载它后面,但是它后面也有可能已经有数据了,所以我们遍历挨个看看是不是我们的数据,是就替换,不是就拼
                for (int binCount = 0; ; ++binCount) {//循环遍历
                    if ((e = p.next) == null) {//拿到当前节点的下一个数据,如果这个数据是null,说明已经到结尾了
                        p.next = newNode(hash, key, value, null);//用要存放的数据创建一个node节点,保存到当前数据的后面
                        if (binCount >= TREEIFY_THRESHOLD - 1) // -1 for 1st// 看看是不是该变成树了
                            treeifyBin(tab, hash);
                        break;
                    }
                    if (e.hash == hash && //当前这个节点的数据和我们要存放的是一样的
                        ((k = e.key) == key || (key != null && key.equals(k))))
                        break;
                    p = e;
                }
            }
            if (e != null) { // existing mapping for key,如果当前存放的的数据已经存在了
                V oldValue = e.value;//用一个变量接收之前的值
                if (!onlyIfAbsent || oldValue == null)
                    e.value = value;//用新的值覆盖掉原先的值
                afterNodeAccess(e);
                return oldValue;//将原先的值返回
            }
        }
        ++modCount;
        if (++size > threshold)//将长度自增,然后看看是不是达到阈值了,如果达到阈值就触发扩容,这个长度是指的存放进来的数据的长度,不是已经使用的数组的位置的长度
            resize();//扩容
        afterNodeInsertion(evict);
        return null;
    }





/**
 * map中数组的扩容方法
 */

    final Node<K,V>[] resize() {
        Node<K,V>[] oldTab = table;//用一个临时变量接受了外面的数组,在第一次的时候这个值是null
        int oldCap = (oldTab == null) ? 0 : oldTab.length;//用一个临时变量接收之前数组的长度,如果这个数组是null的就是0,第一次的时候一定是null,所以老的长度就是0
        int oldThr = threshold;//用一个变量接收老的阈值
        int newCap, newThr = 0;//声明两个变量用于接收新的长度和新的阈值
        if (oldCap > 0) {//老的长度大于0吗? 第一次的是一定不大于,不成立
            if (oldCap >= MAXIMUM_CAPACITY) {
                threshold = Integer.MAX_VALUE;
                return oldTab;
            }
            else if ((newCap = oldCap << 1) < MAXIMUM_CAPACITY &&//我们的新长度等于老长度向左移动一位,也就是乘以2,并且还没达到最大值,并且大于默认值
                     oldCap >= DEFAULT_INITIAL_CAPACITY)
                newThr = oldThr << 1; // double threshold//因为现在长度乘以2了,加载因子没变,所以阈值只需要乘以2就行了
        }
        else if (oldThr > 0) // 老的阈值大于0吗,因为第一次的时候阈值是现在的数组的长度*加载因子,而第一次的时候长度现在没有,所以这个也不大于0 initial capacity was placed in threshold 
            newCap = oldThr;
        else { //无参的初始化方式              // zero initial threshold signifies using defaults
            newCap = DEFAULT_INITIAL_CAPACITY;//新的长度等于默认的长度,也就是16
            newThr = (int)(DEFAULT_LOAD_FACTOR * DEFAULT_INITIAL_CAPACITY);//新的阈值等于默认的加载因子乘以默认的长度 就是0.75*16=12
        }
        if (newThr == 0) {//现在新的阈值有值了,不成立
            float ft = (float)newCap * loadFactor;
            newThr = (newCap < MAXIMUM_CAPACITY && ft < (float)MAXIMUM_CAPACITY ?
                      (int)ft : Integer.MAX_VALUE);
        }
        threshold = newThr;//将新的阈值赋值给外面的阈值成员变量
        @SuppressWarnings({"rawtypes","unchecked"})
        Node<K,V>[] newTab = (Node<K,V>[])new Node[newCap];//根据新的长度创建一个数组,第一次的时候长度是16,以后就是上次的长度乘以2
        table = newTab;//将新的数据赋值给外面的数组成员变量
        if (oldTab != null) {//上面临时保存之前数组的变量,就是扩容之前的数组,在第一次的时候是null,第二次的时候已经不是null
            for (int j = 0; j < oldCap; ++j) {//开始遍历数组中原先的数据,目的是重新计算每个数据应该在的位置,放到新的位置上
                Node<K,V> e;
                if ((e = oldTab[j]) != null) {//老的数组当前位置上有数据,拿到它
                    oldTab[j] = null;//将这个位置的数据置为空,目的是为了加快垃圾回收老数组
                    if (e.next == null)//如果当前数据的下一个是空的
                        newTab[e.hash & (newCap - 1)] = e;//用新的数据的长度-1乘以我这个数据的hash,算出一个位置,把数据放到新的数组的这个位置
                    else if (e instanceof TreeNode)
                        ((TreeNode<K,V>)e).split(this, newTab, j, oldCap);
                    else { // preserve order 如果当前的节点是一个链表,存在多个数据
                        Node<K,V> loHead = null, loTail = null;//保存的是不需要移动的数据的头和尾
                        Node<K,V> hiHead = null, hiTail = null;//记录需要移动的数据的头和尾巴
                        Node<K,V> next;
                        do {
                            next = e.next;//拿到每一个数据
                            if ((e.hash & oldCap) == 0) {//如果hash&原先的长度等于0 ,就代表不需要移动
                                if (loTail == null)//如果表尾巴没有数据,这个数据就是链表的头
                                    loHead = e;
                                else
                                    loTail.next = e;//两边的尾巴的下一个数据就是这个数据
                                loTail = e;//尾巴指向这个数据
                            }
                            else {//这个数据应该是放到新的位置
                                if (hiTail == null)
                                    hiHead = e;//如果新的链表没有数据,这个数据就是头
                                else
                                    hiTail.next = e;//这个数据就放到链表的尾巴,并且这个将尾巴指向这个数据
                                hiTail = e;
                            }
                        } while ((e = next) != null);
                        if (loTail != null) {//尾巴不等于空
                            loTail.next = null;
                            newTab[j] = loHead;//新数据的当前位置就是这个不需要移动的链表
                        }
                        if (hiTail != null) {
                            hiTail.next = null;
                            newTab[j + oldCap] = hiHead;//需要移动的数据就会保存到当前位置加上老的长度(扩容了多少)的位置
                        }
                    }
                }
            }
        }
        return newTab;//返回新的数组
    }

/**
 * 转成树结构
 */

    final void treeifyBin(Node<K,V>[] tab, int hash) {
        int n, index; Node<K,V> e;
        // 如果数组是空的或者数组的长度下雨转成树的最小长度
        if (tab == null || (n = tab.length) < MIN_TREEIFY_CAPACITY)
            resize();//先触发扩容,希望能利用扩容来分散数据
        else if ((e = tab[index = (n - 1) & hash]) != null) {
            TreeNode<K,V> hd = null, tl = null;
            do {
                TreeNode<K,V> p = replacementTreeNode(e, null);
                if (tl == null)
                    hd = p;
                else {
                    p.prev = tl;
                    tl.next = p;
                }
                tl = p;
            } while ((e = e.next) != null);
            if ((tab[index] = hd) != null)
                hd.treeify(tab);
        }
    }
